docs/development/Converting Betaflight Targets.md

   1 If your flight controller does not have an official INAV target, it is possible to use src/utils/bf2inav.py script to generate a good starting point for an unofficial INAV target.
   2
   3 This script can read the config.h from [Betaflight's target configuration repository](https://github.com/betaflight/config) and it currently supports STM32F405, STM32F722, STM32F745, STM32H743 and AT32F435 targets.
   4 Locate your Flight Controller target config.h in BetaFlight's repo, eg.: [config.h](https://github.com/betaflight/config/blob/master/configs/BETAFPVF405/config.h), for BETAFPVF435 target.
   5
   6 It is also advisable to record the output of the timer command from BetaFlight, as it will provide useful information on `timer` usage that can be used to adjust the generated target later.
   7
   8 ```
   9 # timer
  10 timer B08 AF3
  11 # pin B08: TIM10 CH1 (AF3)
  12 timer C08 AF3
  13 # pin C08: TIM8 CH3 (AF3)
  14 timer B00 AF2
  15 # pin B00: TIM3 CH3 (AF2)
  16 timer B01 AF2
  17 # pin B01: TIM3 CH4 (AF2)
  18 timer A03 AF1
  19 # pin A03: TIM2 CH4 (AF1)
  20 timer A02 AF1
  21 # pin A02: TIM2 CH3 (AF1)
  22 timer B06 AF2
  23 # pin B06: TIM4 CH1 (AF2)
  24 timer A08 AF1
  25 # pin A08: TIM1 CH1 (AF1)
  26 timer A09 AF1
  27 # pin A09: TIM1 CH2 (AF1)
  28 timer A10 AF1
  29 # pin A10: TIM1 CH3 (AF1)
  30 ```
  31 In the above example, `pin B08: TIM10 CH1 (AF3)` means that pind to CH1. This information can be used to fix the generated timer assigned to match BetaFlight's allocation by editing the `target.c` file generated by the `bf2inav.py` script.
  32
  33
  34 Using the BETAFPVF405 target mentioned above, to create the target now we need to:
  35
  36 1. Download INAV source code and be able to build
  37 2. Download the config.h from BetaFlight repository
  38 3. Create a target folder that will be used as the output folder for the `bf2inav.py` script, eg: `inav/src/main/targets/BETAFPVF405`
  39 4. Navigate to the script folder in `inav/src/utils/`
  40 5. `python3 ./bf2inav.py -i config.h -o ../main/target/BETAFPVF405/`
  41 6. Edit generated `target.c` and  chose the correct timer definitions to match Betaflight's timer definitions.
  42 ```
  43 timerHardware_t timerHardware[] = {
  44     DEF_TIM(TIM3, CH3, PB0, TIM_USE_OUTPUT_AUTO, 0, 0),
  45     //DEF_TIM(TIM8, CH2N, PB0, TIM_USE_OUTPUT_AUTO, 0, 0),
  46     //DEF_TIM(TIM1, CH2N, PB0, TIM_USE_OUTPUT_AUTO, 0, 0),
  47
  48     DEF_TIM(TIM3, CH4, PB1, TIM_USE_OUTPUT_AUTO, 0, 0),
  49     //DEF_TIM(TIM8, CH3N, PB1, TIM_USE_OUTPUT_AUTO, 0, 0),
  50     //DEF_TIM(TIM1, CH3N, PB1, TIM_USE_OUTPUT_AUTO, 0, 0),
  51
  52     //DEF_TIM(TIM5, CH4, PA3, TIM_USE_OUTPUT_AUTO, 0, 0),
  53     //DEF_TIM(TIM9, CH2, PA3, TIM_USE_OUTPUT_AUTO, 0, 0),
  54     DEF_TIM(TIM2, CH4, PA3, TIM_USE_OUTPUT_AUTO, 0, 0),
  55
  56     //DEF_TIM(TIM5, CH3, PA2, TIM_USE_OUTPUT_AUTO, 0, 0),
  57     //DEF_TIM(TIM9, CH1, PA2, TIM_USE_OUTPUT_AUTO, 0, 0),
  58     DEF_TIM(TIM2, CH3, PA2, TIM_USE_OUTPUT_AUTO, 0, 0),
  59
  60     DEF_TIM(TIM8, CH3, PC8, TIM_USE_OUTPUT_AUTO, 0, 0),
  61     //DEF_TIM(TIM3, CH3, PC8, TIM_USE_OUTPUT_AUTO, 0, 0),
  62
  63     DEF_TIM(TIM1, CH1, PA8, TIM_USE_OUTPUT_AUTO, 0, 0),
  64
  65     //DEF_TIM(TIM3, CH1, PB4, TIM_USE_BEEPER, 0, 0),
  66
  67     DEF_TIM(TIM4, CH1, PB6, TIM_USE_LED, 0, 0),
  68
  69 };
  70 ```
  71 In this particular example, PA3, PA2 were changed to match Betaflight's mapping, and the timer PB4 was disabled, due to a timer conflict. Normal channels are prefered over N channels (CH1, over CH1N) or C channels in AT32 architectures.
  72 7. Now update yout build scripts by running `cmake` and build the target you just created. The target name can be checked in the generated `CMakeLists.txt`, but should match the Betaflight target name.
  73
  74 For information on how to build INAV, check the documents in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.